GET api/status/current/{authenticationToken}/{loanKey}

This method returns the status information for the current status on a loan.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authenticationToken

Current authentication token

 string

Required
loanKey

The loan key string identifying the desired loan

 string

Required

Body Parameters

None.

Response Information

Resource Description

The Status option currently associated with the loan.

StatusModel
NameDescriptionTypeAdditional information
RecordId

This is the record id for a status associated to a loan. This will be 0 (zero) when looking at generic status information from setups.

 integer

None.
Id

This is the id for the status.

 integer

None.
Alias

This is an alias field for the status. This value is used to change a loan's status.

 string

None.
Description

This is the description of the status.

 string

None.
Priority

This field specifies the order in which the status options are sorted, lowest priority to highest.

 integer

None.
IsCompleted

This flag indicates whether the status is a status indicating that the loan is completed.

 boolean

None.
DateEntered

This is a loan level status field and shows when the loan entered this status. A DateTime of '1800-01-01' indicates an invalid (or null) date.

 date

None.
DateCompleted

This is a loan level status field and shows when the loan left this status. A DateTime of '1800-01-01' indicates an invalid (or null) date.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "RecordId": 1,
  "Id": 2,
  "Alias": "sample string 3",
  "Description": "sample string 4",
  "Priority": 5,
  "IsCompleted": true,
  "DateEntered": "2025-07-07T05:27:50.972244-05:00",
  "DateCompleted": "2025-07-07T05:27:50.972244-05:00"
}

application/xml, text/xml

Sample: 
<StatusModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <Alias>sample string 3</Alias>
  <DateCompleted>2025-07-07T05:27:50.972244-05:00</DateCompleted>
  <DateEntered>2025-07-07T05:27:50.972244-05:00</DateEntered>
  <Description>sample string 4</Description>
  <Id>2</Id>
  <IsCompleted>true</IsCompleted>
  <Priority>5</Priority>
  <RecordId>1</RecordId>
</StatusModel>